grideye2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef GRIDEYE2_H
#define GRIDEYE2_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define GRIDEYE2_REG_PCLT               0x00
#define GRIDEYE2_REG_RST                0x01
#define GRIDEYE2_REG_FPSC               0x02
#define GRIDEYE2_REG_INTC               0x03
#define GRIDEYE2_REG_STAT               0x04
#define GRIDEYE2_REG_SCLR               0x05
#define GRIDEYE2_REG_AVE                0x07
#define GRIDEYE2_REG_INTHL              0x08
#define GRIDEYE2_REG_INTHH              0x09
#define GRIDEYE2_REG_INTLL              0x0A
#define GRIDEYE2_REG_INTLH              0x0B
#define GRIDEYE2_REG_IHYSL              0x0C
#define GRIDEYE2_REG_IHYSH              0x0D
#define GRIDEYE2_REG_TTHL               0x0E
#define GRIDEYE2_REG_TTHH               0x0F
#define GRIDEYE2_REG_INT0               0x10
#define GRIDEYE2_REG_INT1               0x11
#define GRIDEYE2_REG_INT2               0x12
#define GRIDEYE2_REG_INT3               0x13
#define GRIDEYE2_REG_INT4               0x14
#define GRIDEYE2_REG_INT5               0x15
#define GRIDEYE2_REG_INT6               0x16
#define GRIDEYE2_REG_INT7               0x17
#define GRIDEYE2_REG_AVE_SET            0x1F
#define GRIDEYE2_REG_TO1L               0x80
#define GRIDEYE2_REG_TO1H               0x81
 // grideye2_reg



#define GRIDEYE2_PCLT_NORMAL_MODE       0x00
#define GRIDEYE2_PCLT_SLEEP_MODE        0x10

#define GRIDEYE2_RST_FLAG               0x30
#define GRIDEYE2_RST_INITIAL            0x3F

#define GRIDEYE2_FPSC_10FPS             0x00
#define GRIDEYE2_FPSC_1FPS              0x01

#define GRIDEYE2_INTC_INTMOD_DIFF       0x00
#define GRIDEYE2_INTC_INTMOD_ABS        0x02
#define GRIDEYE2_INTC_INTMOD_MASK       0x02
#define GRIDEYE2_INTC_INTEN_INACTIVE    0x00
#define GRIDEYE2_INTC_INTEN_ACTIVE      0x01
#define GRIDEYE2_INTC_INTEN_MASK        0x01

#define GRIDEYE2_STAT_OVF_IRS           0x04
#define GRIDEYE2_STAT_INTF              0x02

#define GRIDEYE2_AVE_MAMOD_OFF          0x00
#define GRIDEYE2_AVE_MAMOD_ON           0x20
#define GRIDEYE2_AVE_SET_0              0x50
#define GRIDEYE2_AVE_SET_1              0x45
#define GRIDEYE2_AVE_SET_2              0x57
#define GRIDEYE2_AVE_SET_3              0x00

#define GRIDEYE2_DATA_SIGN_BIT          0x0800
#define GRIDEYE2_DATA_FILL_SIGN         0xF000
#define GRIDEYE2_DATA_LSB               0.25f
#define GRIDEYE2_NUM_PIXELS             64

#define GRIDEYE2_DEVICE_ADDRESS_0       0x68
#define GRIDEYE2_DEVICE_ADDRESS_1       0x69
 // grideye2_set



#define GRIDEYE2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // grideye2_map // grideye2

typedef struct
{
    // Input pins
    digital_in_t int_pin;       
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
    
    float grid_temp[ GRIDEYE2_NUM_PIXELS ]; 
 
} grideye2_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t int_pin;         
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} grideye2_cfg_t;

typedef enum
{
    GRIDEYE2_OK = 0,
    GRIDEYE2_ERROR = -1
 
} grideye2_return_value_t;


void grideye2_cfg_setup ( grideye2_cfg_t *cfg );

err_t grideye2_init ( grideye2_t *ctx, grideye2_cfg_t *cfg );

err_t grideye2_default_cfg ( grideye2_t *ctx );

err_t grideye2_write_reg_bytes ( grideye2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t grideye2_write_reg_byte ( grideye2_t *ctx, uint8_t reg, uint8_t data_in );

err_t grideye2_write_reg_word ( grideye2_t *ctx, uint8_t reg, uint16_t data_in );

err_t grideye2_read_reg_bytes ( grideye2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

err_t grideye2_read_reg_byte ( grideye2_t *ctx, uint8_t reg, uint8_t *data_out );

err_t grideye2_read_reg_word ( grideye2_t *ctx, uint8_t reg, uint16_t *data_out );

uint8_t grideye2_get_int_pin ( grideye2_t *ctx );

err_t grideye2_read_grid ( grideye2_t *ctx );

err_t grideye2_clear_status ( grideye2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // GRIDEYE2_H
 // grideye2
 
// ------------------------------------------------------------------------ END